home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / Net_SmartIRC / README < prev   
Encoding:
Text File  |  2004-03-24  |  2.0 KB  |  90 lines
  1. /**
  2.  * $Id: README,v 1.1.2.1 2003/07/22 17:57:47 meebey Exp $
  3.  * $Revision: 1.1.2.1 $
  4.  * $Author: meebey $
  5.  * $Date: 2003/07/22 17:57:47 $
  6.  */
  7.  
  8. Net_SmartIRC
  9. ----------------
  10. What is this?
  11. Net_SmartIRC is a PHP class for communication with IRC networks, which
  12. conforms to the RFC 2812 (IRC Protocol). It's an API that handles all IRC
  13. protocol messages. It is designed for creating IRC bots, chats and show irc
  14. related info on webpages.
  15.  
  16. Please report bugs to:
  17. http://sourceforge.net/tracker/?group_id=60664&atid=494859
  18.  
  19. Project Homepage:
  20. http://sourceforge.net/projects/phpsmartirc
  21.  
  22. official PEAR package page:
  23. http://pear.php.net/package-info.php?package=Net_SmartIRC
  24.  
  25. files included in SmartIRC
  26. --------------------------
  27. SmartIRC.php
  28. The class itself.
  29.  
  30. FEATURES
  31. A full list of features that SmartIRC includes
  32.  
  33. CHANGELOG
  34. Listing of changes between all versions.
  35.  
  36. README
  37. this file
  38.  
  39. LICENSE
  40. The license of Net_SmartIRC.
  41.  
  42. CREDITS
  43. Creditlist with people that work/help on Net_SmartIRC.
  44.  
  45. SmartIRC/
  46.  defines.php
  47.  Nessesary IRC related defines (IRC reply codes).
  48.  
  49.  messagehandler.php
  50.  All defined messagehandler that SmartIRC currently uses for channelsynching
  51.  and some other API handling.
  52.  
  53.  irccommands.php
  54.  All supported IRC commands (like join/part/kick/etc..)
  55.  
  56. docs/
  57.  DOCUMENTATION
  58.  Appendix to the HTML documention for developers.
  59.  
  60.  HOWTO
  61.  Mini howto with detailed information, step by step.
  62.  
  63.  HTML/
  64.   index.html
  65.   the full documenation of SmartIRC
  66.  
  67. examples/
  68.  example.php
  69.  An example of how you can use this class for a mini php bot.
  70.  
  71.  example2.php
  72.  This example shows how to display the amount of users in a specific
  73.  IRC channel on your homepage.
  74.  
  75.  example3.php
  76.  This bot echos the oplist if !ops is said on the channel.
  77.  
  78.  example4.php
  79.  This bot checks all realnames of people that are on the channel
  80.  and displays the result.
  81.  
  82.  example5.php
  83.  This bot can kicks users when !kick NICKNAME is said on the channel.
  84.  
  85.  example6.php
  86.  This example shows how an onjoin greeting can be done with SmartIRC.
  87.  
  88.  example7.php
  89.  This is an example how timers can be used and how to unregister them.
  90.